Address Lookup API

1.0.x
(1 review)

Error Codes

Error Code Http Status Code API Endpoint/ Resource Reason for the Error Error Cause
AA-400-1 400 – Bad Request Auto Fuzzy Complete
Address Details 		Missing mandatory header {M}:
  • X-Transaction-Id
 Required header {M} not specified.
AA-400-2 400 – Bad Request Auto Fuzzy Complete Missing mandatory address string query parameter {M}:
  • q
 Required query parameter {M} not specified.
AA-400-3 400 – Bad Request Auto Fuzzy Complete Invalid value {X} with data type {T} for a query parameter {Q}:
  • pageSize {type = Integer}
  • page {type = Integer}
  • fuzzy {type = Boolean}
  • q {type = String}
 Invalid value {X} for query parameter {Q}. Invalid type {T}, expected {type}
AA-400-4 400 – Bad Request Auto Fuzzy Complete Invalid range value {X} for a query parameter {Q}:
  • pageSize {min = 1, max = 20}
  • page {min = 1, max = 2147483647}
 Invalid value {X} for query parameter {Q}. Expected number between {min} and {max}
AA-400-5 400 – Bad Request Address Details Invalid address identifier type {X}. Only possible identifiers are:
  • tui
  • tlc
  • plsam
  • aid
 Invalid address identifier {X}. Expected either tui, tlc, plsam or aid
AA-400-6 400 – Bad Request Address Details Invalid address identifier value {X} for address identifier type {A}.
  • tui {type = Integer, max = 10 digits}
  • tlc {type = Integer, max = 9 digits }
  • plsam {type = Integer, max = 7 digits}
  • aid {type = String, prefix = A, length = 11}
 Invalid value {X} for {A}. Expected {type}, {constraint}
AA-404-1 404 – Not Found Address Details No address details found for a specified address identifier. An address could not be found matching the supplied address identifier.
AA-404-2 404 – Not Found Auto Fuzzy Complete Invalid resource {X} after base URI /api (e.g. /api/addrezzez instead of addresses). Invalid URI {X} encountered.
AA-405-1 405 – Method Not Allowed Auto Fuzzy Complete
Address Details 		A request method is not supported for the requested resource; for example, a POST request is used to call GET address details. Unsupported HTTP method encountered.
AA-406-1 406 – Not Acceptable Auto Fuzzy Complete
Address Details 		Potentially caused by an 'Accept' request header other than 'application/json'. Request not acceptable.
AA-500-1 500 – Internal Server Error Auto Fuzzy Complete
Address Details 		There was an unexpected exception and/or condition encountered and needs further investigation. Unable to process your request due to an unexpected error.
AA-500-2 500 – Internal Server Error Address Details Data integrity issue. An address detail should not have multiple TLCs. Unexpected multiple TLCs found in the address record.
AA-500-3 500 – Internal Server Error Address Details Data integrity issue. An address detail should not have multiple PLSAMs. Unexpected multiple PLSAMs found in the address record.
AA-503-1 503 – Service Unavailable Auto Fuzzy Complete
Address Details 		The service is unavailable because a dependent system is not available (e.g. Core Logic’s Address Right API). The server is currently unable to handle the request due to a temporary overload or scheduled maintenance.

Reviews